<!DOCTYPE html>
<html lang="en-US">
    <head>
        <title>Test::API - Test a list of subroutines provided by a module - metacpan.org</title>
        <link rel="preload" as="fetch" href="https://metacpan.org/account/login_status" crossorigin="anonymous" />
        <link href="https://metacpan.org/_assets/b8ccceeed47a0652049703d99326a9cea4933443.css" rel="stylesheet" type="text/css">
        <script src="https://metacpan.org/_assets/6bfedafe2d7caa915b7d84f61b45936818e3242e.js" type="text/javascript" defer></script>
        <link rel="alternate" type="application/rss+xml" title="Recent CPAN Uploads of Test-API - MetaCPAN" href="https://metacpan.org/dist/Test-API/releases.rss" />
        <link rel="canonical" href="./Test::API.html" />
        <meta name="description" content="Test a list of subroutines provided by a module" />
        <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=5">
        <link rel="shortcut icon" href="https://metacpan.org/static/icons/favicon.ico">
        <link rel="apple-touch-icon" sizes="152x152" href="https://metacpan.org/static/icons/apple-touch-icon.png">
        <link rel="search" href="https://metacpan.org/static/opensearch.xml" type="application/opensearchdescription+xml" title="MetaCPAN">
        <script>
          (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
          (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
          m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
          })(window,document,'script','//www.google-analytics.com/analytics.js','ga');

          (function(skey, ga_id){
            ga('create', ga_id, {
              siteSpeedSampleRate : 100,
              storage             : 'none',
              clientId            : localStorage.getItem(skey)
            });
            ga(function(tracker) {
              localStorage.setItem(skey, tracker.get('clientId'));
            });
            ga('send', 'pageview');
          })('ga:clientId', 'UA-27829474-1');
        </script>
<meta name="twitter:card"        content="summary" />
<meta name="twitter:url"         content="https://metacpan.org/pod/Test::API" />
<meta name="twitter:title"       content="Test::API" />
<meta name="twitter:description" content="Test a list of subroutines provided by a module" />
<meta name="twitter:site"        content="metacpan" />
    </head>
    <body>
        <nav class="navbar navbar-default" role="navigation">
            <div class="header-logo-large hidden-xs">
              <a href="https://metacpan.org/" tabindex="0">
                <svg class="logo" aria-label="MetaCPAN">
                  <use class="logo" href="/static/images/metacpan-logo.svg#logo" />
                </svg>
              </a>
            </div>
            <div class="header-logo-icon visible-xs">
              <a href="https://metacpan.org/">
                <svg class="logo" aria-label="MetaCPAN">
                  <use class="logo" href="/static/images/metacpan-logo.svg#dots" />
                </svg>
              </a>
            </div>
            <ul class="nav navbar-nav menu-items hidden-xs hidden-sm">
              <li><a href="https://metacpan.org/about">About</a></li>
              <li><a href="https://metacpan.org/about/sponsors">Sponsor</a></li>
              <li><a href="https://grep.metacpan.org/">grep::cpan</a></li>
              <li><a href="https://metacpan.org/recent">Recent</a></li>
              <li><a href="https://metacpan.org/about/faq">FAQ</a></li>
              <li><a href="https://metacpan.org/tools">Tools</a></li>
              <li><a href="https://fastapi.metacpan.org/">API</a></li>
            </ul>
            <ul class="nav navbar-nav navbar-right">
                <button type="button" class="searchbar-btn visible-xs visible-sm">
                    <i class="fa fa-search button-fa-icon"></i>
                </button>
                <form action="https://metacpan.org/search" class="searchbar-form visible-md visible-lg search-form form-horizontal">
                   <input type="hidden" name="size" id="metacpan_search-size" value="20">
                  <div class="form-group">
                      <div class="search-group">
                        <i class="fa fa-search"></i>
                        <input type="text" name="q" placeholder="Search the CPAN" size="41" autocorrect="off" autocapitalize="off" spellcheck="false" id="metacpan_search-input" class="form-control" value="">
                      </div>
                  </div>
                </form>
                    <li class="icon-slidepanel visible-xs visible-sm">
                      <button data-toggle="slidepanel" data-target=".slidepanel">
                        <span class="button-fa-icon">
                          <i class="fa fa-bars slidepanel-open"></i>
                          <i class="fa fa-times slidepanel-close"></i>
                        </span>
                      </button>
                    </li>
                <form action="https://metacpan.org/account/logout" method="POST" id="metacpan-logout"></form>
                <li class="dropdown logged_in" style="display: none;">
                    <button type="button" class="dropdown-toggle" data-toggle="dropdown">
                      <i class="fa fa-user button-fa-icon logged-in-icon" aria-hidden="true"></i>
                      <i class="fas fa-chevron-down"></i>
                    </button>
                    <ul class="dropdown-menu">
                        <li><a href="https://metacpan.org/account/identities">Identities</a></li>
                        <li><a href="https://metacpan.org/account/profile">Profile</a></li>
                        <li><a href="https://metacpan.org/account/favorite/list">Favorites</a></li>
                        <li>
                            <a href="./Test::API.html#" type="button" onclick="$('#metacpan-logout').submit(); return false">
                              Logout
                            </a>
                        </li>
                    </ul>
                </li>
                <li class="dropdown logged_out" style="display: none;">
                    <button type="button" class="dropdown-toggle" data-toggle="dropdown">
                      <i class="fa fa-user button-fa-icon" aria-hidden="true"></i>
                      <i class="fas fa-chevron-down"></i>
                    </button>
                    <ul class="dropdown-menu">
                        <li>
                            <a href="https://metacpan.org/login/github">
                                <i class="fab fa-github fa-fw"></i>
                                GitHub
                            </a>
                        </li>
                        <li>
                            <a href="https://metacpan.org/login/twitter">
                                <i class="fab fa-twitter fa-fw"></i>
                                Twitter
                            </a>
                        </li>
                        <li>
                            <a href="https://metacpan.org/login/google">
                                <i class="fab fa-google fa-fw"></i>
                                Google
                            </a>
                        </li>
                    </ul>
                </li>
                <li class="dropdown logged_placeholder">
                    <button>
                      <i class="fa fa-user button-fa-icon" aria-hidden="true"></i>
                    </button>
                </li>
            </ul>
        </nav>
        <div class="page-content ">
          <!--
          <div class="top-notify-banner">
            <i class="fas fa-info-circle"></i>
          </div>
          -->
          <nav class="sidebar">
            <div class="slidepanel">
              <ul class="nav-list ">
    <li class="nav-header no-margin-top">
      <div class="ttip" data-toggle="tooltip" data-placement="bottom" title="The date that this version of Test-API was released.">
      <span class="relatize">17 Feb 2018 03:01:29 UTC</span>
    </li>
  <li>
    Distribution: <a href="https://metacpan.org/dist/Test-API">Test-API</a>
  </li>
  <li>
    Module version: 0.010
  </li>
  <li>
    <a data-keyboard-shortcut="g s" href="https://metacpan.org/dist/Test-API/source/lib/Test/API.pm">Source</a>
    (<a href="https://metacpan.org/dist/Test-API/source/lib/Test/API.pm?raw=1">raw</a>)
  </li>
  <li>
    <a data-keyboard-shortcut="g b" href="https://metacpan.org/dist/Test-API/source/lib/Test">Browse</a>
    (<a href="https://metacpan.org/dist/Test-API/source/lib/Test?raw=1">raw</a>)
  </li>
    <li>
      <a data-keyboard-shortcut="g c" href="https://metacpan.org/dist/Test-API/changes">Changes</a>
    </li>
    <li>
      <a rel="noopener nofollow" class="nopopup" href="https://github.com/dagolden/Test-API">Homepage</a>
    </li>
    <li>
      <a class="nopopup" href="https://metacpan.org/dist/Test-API/contribute">How to Contribute</a>
    </li>
    <li>
        <a rel="noopener nofollow" data-keyboard-shortcut="g r" href="https://github.com/dagolden/Test-API">Repository</a>
    </li>
    <li>
      <a rel="noopener nofollow" data-keyboard-shortcut="g i" href="https://github.com/dagolden/Test-API/issues">Issues</a>
    </li>
    <li>
      <a rel="noopener nofollow" href="http://matrix.cpantesters.org/?dist=Test-API+0.010" title="Matrix">Testers</a>
        <span title="(pass / fail / na)">(<a rel="noopener nofollow" href="https://www.cpantesters.org/distro/T/Test-API.html?oncpan=1&amp;distmat=1&amp;version=0.010&amp;grade=2" style="color: #090">8006</a> / <a rel="noopener nofollow" href="https://www.cpantesters.org/distro/T/Test-API.html?oncpan=1&amp;distmat=1&amp;version=0.010&amp;grade=3" style="color: #900">3</a> / <a rel="noopener nofollow" href="https://www.cpantesters.org/distro/T/Test-API.html?oncpan=1&amp;distmat=1&amp;version=0.010&amp;grade=4">0</a>)</span>
    </li>
    <li>
      <a rel="noopener nofollow" href="http://cpants.cpanauthors.org/release/DAGOLDEN/Test-API-0.010">Kwalitee</a>
    </li>
    <li>
      <div class="ttip" data-toggle="tooltip" data-placement="bottom" title="The # people with an indexing permission on Test-API who have released something to CPAN in the last 2 years (i.e. the # people likely able to release critical fixes in a timely manner)">
      Bus factor: 1
      </div>
    </li>
    <li>
      <a rel="noopener nofollow" href="http://cpancover.com/latest/Test-API-0.010/index.html">97.99% Coverage </a>
    </li>
    <li>
      License: apache_2_0
    </li>
    <li>
      Perl: v5.6.0
    </li>
    <li class="nav-header">Activity</li>
    <li>
<div class="activity-graph">
    <img src="https://metacpan.org/dist/Test-API/activity.svg?res=month" />
    <div class="comment">24 month</div>
</div>
    </li>
    <li class="nav-header">Tools</li>
    <li>
      <a itemprop="downloadUrl" href="https://cpan.metacpan.org/authors/id/D/DA/DAGOLDEN/Test-API-0.010.tar.gz">
      Download (<span itemprop="fileSize">17.21KB</span>)</a>
    </li>
    <li>
      <a href="https://explorer.metacpan.org/?url=%2Fmodule%2FDAGOLDEN%2FTest-API-0.010%2Flib%2FTest%2FAPI.pm">
        MetaCPAN Explorer
      </a>
    </li>
    <li>
      <a href="https://metacpan.org/dist/Test-API/permissions">
        Permissions
      </a>
    </li>
    <li>
      <a href="https://metacpan.org/dist/Test-API/releases.rss">
        Subscribe to distribution
      </a>
    </li>
    <li>
      <button class="btn btn-link" data-toggle="modal" data-target="#metacpan_install-instructions-dialog">
        Install Instructions
      </button>
    </li>
    <li>
      <form action="https://metacpan.org/search">
        <input type="hidden" name="q" value="dist:Test-API">
        <input type="search" name="q" placeholder="Search distribution" class="form-control tool-bar-form">
        <input type="submit" style="display: none">
      </form>
    </li>
    <li>
      <form action="https://grep.metacpan.org/search">
        <input type="hidden" name="qd" value="Test-API">
        <input type="hidden" name="source" value="metacpan">
        <input type="search" name="q" placeholder="grep distribution" class="form-control tool-bar-form">
        <input type="submit" style="display: none">
     </form>
    </li>
    <li class="version-jump">
<select onchange="document.location.href=&#39;/release/&#39;+this.value+&#39;/view/lib/Test/API.pm&#39;" class="form-control tool-bar-form">
  <option disabled selected>Jump to version</option>
<option
  disabled
  value="DAGOLDEN/Test-API-0.010"
>0.010
  (DAGOLDEN on 2018-02-17)</option>
<option
  
  value="DAGOLDEN/Test-API-0.009-TRIAL"
>0.009-TRIAL DEV
  (DAGOLDEN on 2018-01-22)</option>
<option
  
  value="DAGOLDEN/Test-API-0.008"
>0.008
  (DAGOLDEN on 2017-04-02)</option>
<option
  
  value="DAGOLDEN/Test-API-0.007-TRIAL"
>0.007-TRIAL DEV
  (DAGOLDEN on 2017-02-27)</option>
<option
  
  value="DAGOLDEN/Test-API-0.005"
>0.005
  (DAGOLDEN on 2014-04-24)</option>
<option
  
  value="DAGOLDEN/Test-API-0.004"
>0.004
  (DAGOLDEN on 2014-03-14)</option>
<option
  
  value="DAGOLDEN/Test-API-0.003"
>0.003
  (DAGOLDEN on 2014-02-27)</option>
<optgroup label="BackPAN">'
<option
  
  value="DAGOLDEN/Test-API-0.002"
>0.002
  (DAGOLDEN on 2009-03-09)</option>
<option
  
  value="DAGOLDEN/Test-API-0.001"
>0.001
  (DAGOLDEN on 2009-03-08)</option>
</optgroup>
</select>
    </li>
    <li class="version-diff">
<select onchange="document.location.href='/release/DAGOLDEN/Test-API-0.010/diff/' + encodeURIComponent(this.value) + '/lib/Test/API.pm'
" class="form-control tool-bar-form">
  <option disabled selected>Diff with version</option>
<option
  disabled
  value="DAGOLDEN/Test-API-0.010"
>0.010
  (DAGOLDEN on 2018-02-17)</option>
<option
  
  value="DAGOLDEN/Test-API-0.009-TRIAL"
>0.009-TRIAL DEV
  (DAGOLDEN on 2018-01-22)</option>
<option
  
  value="DAGOLDEN/Test-API-0.008"
>0.008
  (DAGOLDEN on 2017-04-02)</option>
<option
  
  value="DAGOLDEN/Test-API-0.007-TRIAL"
>0.007-TRIAL DEV
  (DAGOLDEN on 2017-02-27)</option>
<option
  
  value="DAGOLDEN/Test-API-0.005"
>0.005
  (DAGOLDEN on 2014-04-24)</option>
<option
  
  value="DAGOLDEN/Test-API-0.004"
>0.004
  (DAGOLDEN on 2014-03-14)</option>
<option
  
  value="DAGOLDEN/Test-API-0.003"
>0.003
  (DAGOLDEN on 2014-02-27)</option>
<optgroup label="BackPAN">'
<option
  
  value="DAGOLDEN/Test-API-0.002"
>0.002
  (DAGOLDEN on 2009-03-09)</option>
<option
  
  value="DAGOLDEN/Test-API-0.001"
>0.001
  (DAGOLDEN on 2009-03-08)</option>
</optgroup>
</select>
    </li>

    <li>
<ul class="dependencies">
  <li class="nav-header">Dependencies</li>
  <li><a href="https://metacpan.org/pod/Symbol" title="Symbol" class="ellipsis">Symbol</a></li>
  <li><a href="https://metacpan.org/pod/Test::Builder::Module" title="Test::Builder::Module" class="ellipsis">Test::Builder::Module</a></li>
  <li><a href="https://metacpan.org/pod/strict" title="strict" class="ellipsis">strict</a></li>
  <li><a href="https://metacpan.org/pod/warnings" title="warnings" class="ellipsis">warnings</a></li>
  <li>
    <hr>
  </li>
  <li>
    <a href="https://metacpan.org/module/Test::API/requires">Reverse dependencies</a>
  </li>
  <li>
    <a href="http://deps.cpantesters.org/?module=Test%3A%3AAPI">CPAN Testers List</a>
  </li>
  <li>
    <a href="https://cpandeps.grinnz.com/?dist=Test-API">Dependency graph</a>
  </li>
</ul>
    </li>
    <li class="nav-header">Permalinks</li>
    <li>
      <a href="https://metacpan.org/release/DAGOLDEN/Test-API-0.010/view/lib/Test/API.pm">This version</a>
    </li>
    <li>
      <a href="./Test::API.html">Latest version</a>
    </li>
    <li>
<div class="plussers">
<div class="nav-header">++ed by:</div>
<div>
    1 non-PAUSE user
</div>
</div>
    </li>
    <li>
<div id="metacpan_contributors">
  <div>
    <button class="btn-link"
      onclick="$(this).hide(); $('#metacpan_contributors ul').slideDown(); return false;"
    >and 2 contributors</button>
  </div>
  <ul style="display: none">
    <li class="contributor"
      data-contrib-email="cpansprout@gmail.com"
    >
      <img class="gravatar" width="20" height="20" src="https://www.gravatar.com/avatar/d41d8cd98f00b204e9800998ecf8427e?d=identicon&amp;s=20" />
      cpansprout
    </li>
    <li class="contributor"
      data-contrib-email="mail@tobyinkster.co.uk"
    >
      <img class="gravatar" width="20" height="20" src="https://www.gravatar.com/avatar/d41d8cd98f00b204e9800998ecf8427e?d=identicon&amp;s=20" />
      Toby Inkster
    </li>
  </ul>
</div>
    </li>
              </ul>
            </div>
          </nav>
          <div class="content-navigation">
<div class="breadcrumbs">
  <span>
    <a data-keyboard-shortcut="g a" rel="author" href="https://metacpan.org/author/DAGOLDEN" class="author-name">David Golden</a>
  </span>
  <span>&nbsp;/&nbsp;</span>
  <div class="release dist-release status-latest maturity-released">
    <span class="dropdown"><b class="caret"></b></span>
<select onchange="document.location.href=&#39;/release/&#39;+this.value+&#39;/view/lib/Test/API.pm&#39;" class="">
<option
  selected
  value="DAGOLDEN/Test-API-0.010"
>0.010
  (DAGOLDEN on 2018-02-17)</option>
<option
  
  value="DAGOLDEN/Test-API-0.009-TRIAL"
>0.009-TRIAL DEV
  (DAGOLDEN on 2018-01-22)</option>
<option
  
  value="DAGOLDEN/Test-API-0.008"
>0.008
  (DAGOLDEN on 2017-04-02)</option>
<option
  
  value="DAGOLDEN/Test-API-0.007-TRIAL"
>0.007-TRIAL DEV
  (DAGOLDEN on 2017-02-27)</option>
<option
  
  value="DAGOLDEN/Test-API-0.005"
>0.005
  (DAGOLDEN on 2014-04-24)</option>
<option
  
  value="DAGOLDEN/Test-API-0.004"
>0.004
  (DAGOLDEN on 2014-03-14)</option>
<option
  
  value="DAGOLDEN/Test-API-0.003"
>0.003
  (DAGOLDEN on 2014-02-27)</option>
<optgroup label="BackPAN">'
<option
  
  value="DAGOLDEN/Test-API-0.002"
>0.002
  (DAGOLDEN on 2009-03-09)</option>
<option
  
  value="DAGOLDEN/Test-API-0.001"
>0.001
  (DAGOLDEN on 2009-03-08)</option>
</optgroup>
</select>
    <a data-keyboard-shortcut="g d" class="release-name" href="https://metacpan.org/dist/Test-API">Test-API-0.010</a>
  </div>
<span class="river-gauge-gauge">
  <svg width="24px"
       height="15px"
       version="1.1"
       xmlns="http://www.w3.org/2000/svg"
       xmlns:xlink="http://www.w3.org/1999/xlink">

    <g>
      <title>        River stage three &#10;
          • 4 direct dependents &#10;          • 149 total dependents
      </title>

      <rect x="0"  y="0" width="4" height="15" fill="#7ea3f2" />
      <rect x="5"  y="0" width="4" height="15" fill="#7ea3f2" />
      <rect x="10"  y="0" width="4" height="15" fill="#7ea3f2" />
      <rect x="15"  y="0" width="4" height="15" fill="#e4e2e2" />
      <rect x="20"  y="0" width="4" height="15" fill="#e4e2e2" />
    </g>
  </svg>

</span>
<div id="Test-API-fav" class="logged_in">
<form action="https://metacpan.org/account/favorite/add" style="display: inline" onsubmit="return favDistribution(this)">
    <input type="hidden" name="remove" value="0">
    <input type="hidden" name="release" value="Test-API-0.010">
    <input type="hidden" name="author" value="DAGOLDEN">
    <input type="hidden" name="distribution" value="Test-API">
    <button type="submit" class="favorite highlight"><span>1</span> ++</button>
</form>
</div>
<div class="logged_out">
<a href="./Test::API.html" onclick="alert('Please sign in to add favorites'); return false" class="favorite highlight">
<span>1</span> ++</a>
</div>
   / <span>Test::API</span>
</div>
          </div>
          <main class="content">


<nav class="toc">
  <div class="toc-header"><strong>Contents</strong></div>
<ul>
  <li><a href="./Test::API.html#NAME">NAME</a></li>
  <li><a href="./Test::API.html#VERSION">VERSION</a></li>
  <li><a href="./Test::API.html#SYNOPSIS">SYNOPSIS</a></li>
  <li><a href="./Test::API.html#DESCRIPTION">DESCRIPTION</a></li>
  <li><a href="./Test::API.html#USAGE">USAGE</a>
    <ul>
      <li><a href="./Test::API.html#public_ok">public_ok</a></li>
      <li><a href="./Test::API.html#class_api_ok">class_api_ok</a></li>
      <li><a href="./Test::API.html#import_ok">import_ok</a></li>
    </ul>
  </li>
  <li><a href="./Test::API.html#SEE-ALSO">SEE ALSO</a></li>
  <li><a href="./Test::API.html#SUPPORT">SUPPORT</a>
    <ul>
      <li><a href="./Test::API.html#Bugs-/-Feature-Requests">Bugs / Feature Requests</a></li>
      <li><a href="./Test::API.html#Source-Code">Source Code</a></li>
    </ul>
  </li>
  <li><a href="./Test::API.html#AUTHOR">AUTHOR</a></li>
  <li><a href="./Test::API.html#CONTRIBUTORS">CONTRIBUTORS</a></li>
  <li><a href="./Test::API.html#COPYRIGHT-AND-LICENSE">COPYRIGHT AND LICENSE</a></li>
</ul></nav>
<div class="pod anchors">
<h1 id="NAME">NAME</h1>

<p>Test::API - Test a list of subroutines provided by a module</p>

<h1 id="VERSION">VERSION</h1>

<p>version 0.010</p>

<h1 id="SYNOPSIS">SYNOPSIS</h1>

<pre><code>    use Test::More tests =&gt; 3;
    use Test::API;

    require_ok( &#39;My::Package&#39; );

    public_ok ( &#39;My::Package&#39;, @names );

    import_ok ( &#39;My::Package&#39;,
        export    =&gt; [ &#39;foo&#39;, &#39;bar&#39; ],
        export_ok =&gt; [ &#39;baz&#39;, &#39;bam&#39; ],
    );

    class_api_ok( &#39;My::Class&#39;, @methods );</code></pre>

<h1 id="DESCRIPTION">DESCRIPTION</h1>

<p>This simple test module checks the subroutines provided by a module. This is useful for confirming a planned API in testing and ensuring that other functions aren&#39;t unintentionally included via import.</p>

<h1 id="USAGE">USAGE</h1>

<p>Note: Subroutines starting with an underscore are ignored, as are a number of other methods not intended to be called directly by end-users.</p>

<pre><code>  import unimport bootstrap

  AUTOLOAD BUILD BUILDARGS CLONE CLONE_SKIP DESTROY DEMOLISH

  TIESCALAR TIEARRAY TIEHASH TIEHANDLE

  FETCH STORE UNTIE FETCHSIZE STORESIZE POP PUSH SHIFT UNSHIFT SPLICE
  DELETE EXISTS EXTEND CLEAR FIRSTKEY NEXTKEY PRINT PRINTF WRITE
  READLINE GETC READ CLOSE BINMODE OPEN EOF FILENO SEEK TELL SCALAR

  MODIFY_REF_ATTRIBUTES MODIFY_SCALAR_ATTRIBUTES MODIFY_ARRAY_ATTRIBUTES
  MODIFY_HASH_ATTRIBUTES MODIFY_CODE_ATTRIBUTES MODIFY_GLOB_ATTRIBUTES
  MODIFY_FORMAT_ATTRIBUTES MODIFY_IO_ATTRIBUTES

  FETCH_REF_ATTRIBUTES FETCH_SCALAR_ATTRIBUTES FETCH_ARRAY_ATTRIBUTES
  FETCH_HASH_ATTRIBUTES FETCH_CODE_ATTRIBUTES FETCH_GLOB_ATTRIBUTES
  FETCH_FORMAT_ATTRIBUTES FETCH_IO_ATTRIBUTES</code></pre>

<p>Therefore, do not include any of these in a list of expected subroutines.</p>

<h2 id="public_ok">public_ok</h2>

<pre><code>  public_ok( $package, @names );</code></pre>

<p>This function checks that all of the <code>@names</code> provided are available within the <code>$package</code> namespace and that *only* these subroutines are available. This means that subroutines imported from other modules will cause this test to fail unless they are explicitly included in <code>@names</code>.</p>

<h2 id="class_api_ok">class_api_ok</h2>

<pre><code>  class_api_ok( $class, @names );</code></pre>

<p>A variation of <code>public_ok</code> for object-oriented modules. Allows superclasses to fill in &quot;missing&quot; subroutines, but &quot;extra&quot; methods provided by superclasses will not cause the test to fail.</p>

<h2 id="import_ok">import_ok</h2>

<pre><code>  import_ok ( $package, %spec );</code></pre>

<p>This function checks that <code>$package</code> correctly exports an expected list of subroutines and *only* these subroutines. The <code>%spec</code> generally follows the style used by [Exporter], but in lower case:</p>

<pre><code>  %spec = (
    export    =&gt; [ &#39;foo&#39;, &#39;bar&#39; ],  # exported automatically
    export_ok =&gt; [ &#39;baz&#39;, &#39;bam&#39; ],  # optional exports
  );</code></pre>

<p>For <code>export_ok</code>, the test will check for public functions not listed in <code>export</code> or <code>export_ok</code> that can be imported and will fail if any are found.</p>

<h1 id="SEE-ALSO"><a id="SEE"></a>SEE ALSO</h1>

<ul>

<li><p><a href="https://metacpan.org/pod/Test::ClassAPI">Test::ClassAPI</a> -- more geared towards class trees with inheritance</p>

</li>
</ul>

<h1 id="SUPPORT">SUPPORT</h1>

<h2 id="Bugs-/-Feature-Requests"><a id="Bugs"></a><a id="Bugs---Feature-Requests"></a>Bugs / Feature Requests</h2>

<p>Please report any bugs or feature requests through the issue tracker at <a href="https://github.com/dagolden/Test-API/issues">https://github.com/dagolden/Test-API/issues</a>. You will be notified automatically of any progress on your issue.</p>

<h2 id="Source-Code"><a id="Source"></a>Source Code</h2>

<p>This is open source software. The code repository is available for public review and contribution under the terms of the license.</p>

<p><a href="https://github.com/dagolden/Test-API">https://github.com/dagolden/Test-API</a></p>

<pre><code>  git clone https://github.com/dagolden/Test-API.git</code></pre>

<h1 id="AUTHOR">AUTHOR</h1>

<p>David Golden &lt;dagolden@cpan.org&gt;</p>

<h1 id="CONTRIBUTORS">CONTRIBUTORS</h1>

<ul>

<li><p>cpansprout &lt;cpansprout@gmail.com&gt;</p>

</li>
<li><p>Toby Inkster &lt;mail@tobyinkster.co.uk&gt;</p>

</li>
</ul>

<h1 id="COPYRIGHT-AND-LICENSE"><a id="COPYRIGHT"></a>COPYRIGHT AND LICENSE</h1>

<p>This software is Copyright (c) 2018 by David Golden.</p>

<p>This is free software, licensed under:</p>

<pre><code>  The Apache License, Version 2.0, January 2004</code></pre></div>

<div id="metacpan_install-instructions-dialog" class="modal fade">
  <div class="modal-dialog">
    <div class="modal-content">
      <div class="modal-header">
        <button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>
        <h4 class="modal-title">Module Install Instructions</h4>
      </div>
      <div class="modal-body">
        <p>To install Test::API, copy and paste the appropriate command in to your terminal.</p>
        <p><a href="https://metacpan.org/dist/App-cpanminus/view/bin/cpanm">cpanm</a></p>
        <pre><code>cpanm Test::API</code></pre>
        <p><a href="https://metacpan.org/pod/CPAN">CPAN shell</a></p>
        <pre><code>perl -MCPAN -e shell
install Test::API</code></pre>
        <p>For more information on module installation, please visit <a href="https://www.cpan.org/modules/INSTALL.html">the detailed CPAN module installation guide</a>.</p>
      </div>
      <div class="modal-footer">
        <a href="./Test::API.html#" data-dismiss="modal" class="btn">Close</a>
      </div>
    </div>
  </div>
</div>
          </main>
          <div class="content-pagination">
          </div>
        </div>
        <footer class="footer">
          <div class="footer-container">
            <div class="footer-social">
              <div class="footer-link footer-logo">
                <a href="https://metacpan.org/">
                  <img src="https://metacpan.org/static/images/metacpan-logo.svg" alt="MetaCPAN" />
                </a>
              </div>
              <a class="footer-social-link" href="https://github.com/metacpan">
                <i class="fab fa-github-square"></i>
              </a>
              <a class="footer-social-link" href="https://fosstodon.org/@metacpan">
                <i class="fab fa-mastodon"></i>
              </a>
            </div>
            <div class="footer-links">
              <div class="footer-link">
                  <a href="https://metacpan.org/about">About</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/about/sponsors">Sponsor</a>
              </div>
              <div class="footer-link">
                  <a href="https://grep.metacpan.org">grep::cpan</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/recent">Recent</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/about/faq">FAQ</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/tools">Tools</a>
              </div>
              <div class="footer-link">
                  <a href="https://fastapi.metacpan.org/">API</a>
              </div>
              <div class="footer-link">
                  <a href="https://www.perl.org/">Perl.org</a>
              </div>
            </div>
            <div class="footer-sponsors">
              <a class="footer-sponsor-link" target="_blank" href="https://www.bytemark.co.uk/" rel="noopener">
                <img class="footer-sponsor-bytemark" src="https://metacpan.org/static/images/sponsors/bytemark_logo.svg" alt="Bytemark logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://www.liquidweb.com/" rel="noopener">
                <img class="footer-sponsor-liquidweb" src="https://metacpan.org/static/images/sponsors/liquidweb_logo.png" alt="liquidweb logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://deriv.com/careers/" rel="noopener">
                <img class="footer-sponsor-deriv" src="https://metacpan.org/static/images/sponsors/deriv.svg" alt="Deriv logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://geocode.xyz" rel="noopener">
                <img class="footer-sponsor-geocode" src="https://metacpan.org/static/images/sponsors/geocodelogo.svg" alt="Geocode logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://www.fastly.com/" rel="noopener">
                <img class="footer-sponsor-fastly" src="https://metacpan.org/static/images/sponsors/fastly_logo.svg" alt="Fastly logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://opencagedata.com" rel="noopener">
                <img class="footer-sponsor-opencage" src="https://metacpan.org/static/images/sponsors/open-cage.svg" alt="OpenCage logo">
              </a>
            </div>
          </div>
        </footer>
        <div class="modal fade" tabindex="-1" role="dialog" id="metacpan_keyboard-shortcuts">
          <div class="modal-dialog">
            <div class="modal-content">
              <div class="modal-header">
                <button type="button" class="close" data-dismiss="modal">&times;</button>
                <h4 class="modal-title">Keyboard Shortcuts</h4>
              </div>
              <div class="modal-body row">
<div class="col-md-6">
  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>Global</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td class="keys">
          <kbd>s</kbd>
        </td>
        <td>Focus search bar</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>?</kbd>
        </td>
        <td>Bring up this help dialog</td>
      </tr>
    </tbody>
  </table>

  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>GitHub</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>p</kbd>
        </td>
        <td>Go to pull requests</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>i</kbd>
        </td>
        <td>go to github issues (only if github is preferred repository)</td>
      </tr>
    </tbody>
  </table>
</div>

<div class="col-md-6">
  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>POD</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>a</kbd>
        </td>
        <td>Go to author</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>c</kbd>
        </td>
        <td>Go to changes</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>i</kbd>
        </td>
        <td>Go to issues</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>d</kbd>
        </td>
        <td>Go to dist</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>r</kbd>
        </td>
        <td>Go to repository/SCM</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>s</kbd>
        </td>
        <td>Go to source</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>b</kbd>
        </td>
        <td>Go to file browse</td>
      </tr>

    </tbody>
  </table>
</div>

<div class="col-md-12">
  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>Search terms</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><em>module:</em> (e.g. <a href="https://metacpan.org/search?q=module%3APlugin">module:Plugin</a>)</td>
      </tr>
      <tr>
        <td><em>distribution:</em> (e.g. <a href="https://metacpan.org/search?q=distribution%3ADancer+auth">distribution:Dancer auth</a>)</td>
      </tr>
      <tr>
        <td><em>author:</em> (e.g. <a href="https://metacpan.org/search?q=author%3ASONGMU+Redis">author:SONGMU Redis</a>)</td>
      </tr>
      <tr>
        <td><em>version:</em> (e.g. <a href="https://metacpan.org/search?q=version%3A1.00">version:1.00</a>)</td>
      </tr>
    </tbody>
  </table>
</div>
              </div>
              <div class="modal-footer"></div>
            </div>
          </div>
        </div>
    </body>
</html>
